home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / doors_1 / domino11.zip / DOMINOES.DOC < prev    next >
Text File  |  1992-11-14  |  21KB  |  460 lines
  1.  
  2.                              D O M I N O E S
  3.  
  4.                                   v1.1
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                             (404) 256-9525
  12.  
  13.  
  14.  
  15.  
  16.                                 OVERVIEW
  17.                                 ________
  18.  
  19.  
  20.    Dominoes are played with a Double-Six pack of 28 tiles. The player is
  21.    playing against the computer for points. Scoring encompasses winning and
  22.    losing points, thus making the game very competitive for your callers.
  23.  
  24.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  25.          created in the directory you run the door from.
  26.  
  27.  
  28.  
  29.                               INSTALLATION
  30.                               ____________
  31.  
  32.  
  33.    Installation is fairly easy and straight-forward. The following steps and
  34.    examples should have you up and running in a very short period of time.
  35.    It is assumed that you are familiar with setting up DOORS on your system.
  36.    To this end, only examples of the configuration file and Door batch file
  37.    are described.
  38.  
  39.       1) Create a directory to hold all DOMINOES files
  40.  
  41.       2) Unzip DOMINOxx.ZIP into the the above directory
  42.  
  43.       3) Create a configuration file, with a name of your choice, or
  44.          modify the supplied DOMINOE.CFG file. A description follows:
  45.  
  46.             **                       Location of system file (See Below)
  47.             SUNRISE-80 BBS           Your BBS Name
  48.             Al                       Sysop's First nameAP
  49.  
  50.             Lawrence                 Sysop's Last Name
  51.  
  52. |-----------------------------------------------------------------------------|
  53. | READ!     1                        CommPort  \ These 2 lines are required   |
  54. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  55. |-----------------------------------------------------------------------------|
  56.  
  57.             00000000                 Registration Number
  58.  
  59.         #   2                        Keyboard timeout value in Minutes
  60.  
  61.    !    #   2                        Maximum # of Games per day
  62.                                      (Sysop gets 99 in Registered version)
  63.  
  64.         #   0                        Max # of days a caller can make up, during
  65.                                      calls in one day. 0=Disable Make-up Option
  66.                                      Maximum value = 27, Minimum value = 1
  67.  
  68.         #   N                        Automatic game reset at end of month:
  69.                                        Y = Yes enable autoreset
  70.                                        N = Keep accumulating scores
  71.  
  72.     !   #   0                        Time Allowed in Door
  73.                                      (Sysop = Time Remaining - REG. VERSION)
  74.  
  75.  
  76.             2                        1 = DO NOT Display ADOPT-A-DOOR Message
  77.                                      2 = Display ADOPT-A-DOOR message
  78.  
  79.         #   NONE                     Drive:\Path\Filename to contain the
  80.                                      Top Score Bulletin or enter NONE
  81.                                      for NO Bulletin creation.
  82.  
  83.         #   NONE                     Drive:\Path\Filename to contain the
  84.                                      Top Score Bulletin (Color) or enter NONE
  85.                                      for NO Bulletin creation.
  86.         
  87.         #   NONE                     Drive:\Path\Filename to contain the
  88.                                      Hall of Fame Bulletin or enter NONE
  89.                                      for NO Bulletin creation.
  90.  
  91.         #   NONE                     Drive:\Path\Filename to contain the
  92.                                      Hall of Fame Bulletin (Color) or enter NONE
  93.                                      for NO Bulletin creation.
  94.  
  95.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  96.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  97.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  98.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  99.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  100.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  101.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  102.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  103.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  104.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  105.  
  106.     @   #   XXXX/YYYY                 Blackout Range  From/To
  107.     @   #   XXXX/YYYY                 Blackout Range  From/To
  108.     @   #   XXXX/YYYY                 Blackout Range  From/To
  109.     @   #   XXXX/YYYY                 Blackout Range  From/To
  110.     @   #   XXXX/YYYY                 Blackout Range  From/To
  111.  
  112.           ** = Replace with ONE of the following:
  113.  
  114. C:\PCB\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  115. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  116. C:\BBS\USERINFO.DAT             <- For Wildcat! systems using v3.x
  117.                                    (Note:DOOR.SYS must be in SAME directory)
  118. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  119. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  120. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  121. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  122. C:\BBS\CHAIN.TXT                <- For WWIV systems 
  123. C:\BBS\GTUSER.BBS               <- For GT Power 
  124.                                    * if using this option you must put the
  125.                                      ComPort # on line 5 and the Node # on
  126.                                      line 6 of the configuration file
  127.  
  128.  
  129.            # = Requires registration to change to a different value.
  130.            ! = See "Plays Per Day/Door Time" Below
  131.            @ = See "Blackout Periods" Below
  132.  
  133.                NOTE: There are NO Blank Lines in the Config File!!
  134.  
  135.  
  136.       4) Create a batch file or modify the DOMINOES file supplied. A
  137.          description of this file follows:
  138.  
  139.             ECHO off
  140.             cd\BBS\DOORS\DOMINOES     Location of DOMINOES files
  141.             DOMINOES DOMINOES.CFG     EXE filename and CFG filename (Name
  142.                                       used in creating file in #3 above)
  143.             CD\BBS
  144.             BOARD
  145.  
  146.  
  147.        5) When running in more than one node, be sure to supply a
  148.           different configuration name for each node (or see below).
  149.  
  150.        6) If running with a DigiBoard  or other multi-port boards add
  151.            /FD to the line ocntinaing the CFG name as follows:
  152.  
  153.                       DOMINOES DOMINOES.CFG /FD
  154.  
  155.  
  156.                MAKE-UP DAYS (Registered version only)
  157.                --------------------------------------
  158.  
  159. The Make-Up-Day feature allows the caller to make up any plays he/she missed 
  160. during the current month and prior to the current call. You control whether 
  161. to allow this option, as well as the number of days the caller can make up, on
  162. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  163. configuration file, turns the option OFF, any other value (up to a max of 27)
  164. turns the option ON and dictates the number of days the caller can make up.
  165.  
  166.  
  167. NOTE:      The number of games per day is calculated as follows...
  168.  
  169.            Games Allowed per day x Number of makeup days.
  170.  
  171. Example:   Games Allowed per day = 2
  172.            Max # of makeup days  = 4
  173.  
  174. If a caller logs in on 5/8/92 and this is their first call of the month, they
  175. would have a potential of 16 games to makeup and bring them current 
  176. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  177. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8 
  178. (games allowed * max # of makeup days).
  179.  
  180.  
  181.  
  182.              HALL OF FAME BULLETINS (Registered version only)
  183.              ------------------------------------------------
  184.  
  185. The program will automatically reset the game when the first caller of the
  186. month plays the game. The score file will be cleared and a set of Hall of Fame
  187. bulletin files will be created. The files will be called SUNHOF.ASC and 
  188. SUNHOF.ANS (ASCII and ANSI versions). The files will be placed in the same 
  189. directory as the DOMINOES.EXE file. You are responsible for COPYING the files
  190. to your bulletin area and renaming to a filename of your choice.
  191.  
  192. WARNING: The HOF files are cumulative files. That means they are read in each 
  193.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  194.          the record of prior months winners!!!!
  195.  
  196.  
  197.  
  198.                           BLACKOUT PERIODS
  199.                           ________________
  200.  
  201.       Use the Blackout ranges option to define up to 5 time periods during
  202.       which you DO NOT want the Door to be played. If a caller tries to access 
  203.       the Door during the Blackout period, they will be shown a message that
  204.       contains ALL the Blackout periods you have defined, and to try the Door
  205.       at a later time.
  206.  
  207.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  208.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  209.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  210.  
  211.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  212.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  213.                    a Blackout range.
  214.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  215.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  216.  
  217.  
  218.                           PLAYS Per DAY/DOOR Time
  219.                           _______________________
  220.  
  221.       Plays Per Day and Door Time can be controlled several ways:
  222.  
  223.       (1) You can use the Games Per Day, singular option, in the config
  224.           file above. This option, will affect ALL callers whose Security
  225.           Level is NOT defined in any of the 10 optional Security Level/
  226.           Plays Per Day entries in the config file.
  227.  
  228.       (2) You can use the Door Time, singular option, in the config file
  229.           above. This option, will affect ALL callers whose Security
  230.           Level is NOT defined in any of the 10 optional Security Level/
  231.           Plays Per Day/Door Time entries in the config file.
  232.  
  233.       (3) You can restrict the number of games a specific Security Level
  234.           will be allowed to play per day or REWARD specific Levels with 
  235.           more Plays Per Day. 
  236.  
  237.           Likewise, you can restrict the Play time for a specific Security
  238.           Level or REWARD specific Levels with more Door Time.
  239.  
  240.           These options are handled by the use of the 10 config 
  241.           entries (000=00/00). 
  242.           
  243.           The format of each entry is as follows:
  244.  
  245.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  246.                      where =  is a constant and MUST be included
  247.                      where YY is the # of games per day (must be 2 digits)
  248.                      where / is a constant and MUST be included
  249.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  250.           
  251.           If the callers Security Level is NOT defined, his/her Plays Per
  252.           Day and Door Time will be controlled by the values in items
  253.           (1) and (2), above, respectively..
  254.  
  255.           You may define up to 10 Security Levels. All unused entries must
  256.           be defined as   00=00/00
  257.         --------------------------------------------------------------------
  258.           Example: Suppose you had 3 Security Levels defined on your BBS as
  259.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you 
  260.           wanted to set Plays Per Day as :     Subscriber=5
  261.                                            Visiting Sysop=2
  262.                                                   CoSysop=3
  263.                                                    Friend=10 
  264.           
  265.           and Door Time as follows:     Subscriber=30 minutes
  266.                                     Visiting Sysop=20 minutes
  267.                                            CoSysop=10 minutes 
  268.                                             Friend=remaining call time
  269.                                
  270.  
  271.           You would set the Individual "Games per Day" config entry to 1 and 
  272.           the individual "Door Time" to 5 minutes (these would be the 
  273.           default number of games and default Time for all Security Levels
  274.           other than 20,30 or 40... make them any number you want). Next you
  275.           would replace 4 of the Security Level entries as :  020=05/30                                               
  276.                                                               030=02/20
  277.                                                               040=03/10
  278.                                                               090=10/0
  279.  
  280.  
  281.  
  282.                         NON-STANDARD COM SUPPORT
  283.                         ________________________
  284.  
  285.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  286.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  287.       number after the configuration filename. Let's assume your Door is
  288.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  289.       passed to your Door would be:
  290.  
  291.                             FOOBAR FOOBAR.CFG /5
  292.  
  293.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  294.       normally used with COM1. No /x parameter is needed for the standard
  295.       IRQ's.
  296.  
  297.       As an alternative, you may use an environmental variable on the command
  298.       line. To use the variable (following the example above), place a 
  299.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a 
  300.       different IRQ number for each node). The command line would now look 
  301.       like this: 
  302.  
  303.                           FOOBAR FOOBAR.CFG /%IRQ%
  304.       
  305.       This, in combination with the use of the environmental variables 
  306.       described in the MULTI-NODE SETUP section will allow you to use one 
  307.       batch file and one config file to run this door on all nodes.
  308.  
  309.  
  310.  
  311.  
  312.                            MULTI-NODE SETUP
  313.                            ________________
  314.  
  315.       All Sunrise Doors are Multi-Node capable. Each node must have the 
  316.       ability to access a configuration file which will have its own system 
  317.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first 
  318.       line. There are 2 ways to accomplish this:
  319.  
  320.       (1) Create a separate configuration file for each node. The only 
  321.           difference between each file would be the location of the system 
  322.           file for that particular node. For example, on my system there are 2
  323.           nodes and the first line of the config files would look like this:
  324.  
  325.                         NODE1:  H:\PCB1\DOOR.SYS
  326.                         NODE2:  H:\PCB2\DOOR.SYS
  327.  
  328.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  329.  
  330.       (2) Use ONE configuration file for ALL nodes. This Door will recognize 
  331.           the following PCBoard environmental variables:
  332.  
  333.                  PCBDIR    (Directory containing the System file)
  334.                  PCBDRIVE  (Drive containing the System file)
  335.  
  336.           Thus, the first line of the SINGLE configuration file, for this Door
  337.           would look like this:
  338.  
  339.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  340.  
  341.       NOTE: This option, as described, assumes that you are running PCBoard 
  342.             14.5a software. The environmental variables are automatically 
  343.             created by the software for each node.
  344.  
  345.             HOWEVER, if you are running other BBS software you should be able
  346.             to set the variables EXACTLY as described below, for EACH node 
  347.             (more than likely in each batch file you use to bring up EACH node):
  348.  
  349.                             PCBDRIVE=C:
  350.                             ^^^^^^^^^
  351.                             PCBDIR=\NODE2
  352.                             ^^^^^^^^
  353.             
  354.             Info with a carat (^) under it, MUST be typed as is. The rest 
  355.             depends on your naming conventions. 
  356.  
  357.             This, in combination with the use of the optional environmental
  358.             variable described in the NON-STANDARD COM SUPPORT section, will
  359.             allow you to use one batch file and one config file to run this 
  360.             door on all nodes.
  361.  
  362.  
  363.                                ADOPT-A-DOOR
  364.                                ____________
  365.  
  366.     Having been a Sysop for a number of years, I have had my share of problems
  367.     and frustrations getting financial support for my board's upkeep. A fellow
  368.     Sysop left a message on my board, not long ago, about a concept that was
  369.     being used by several boards around the country.
  370.  
  371.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  372.     would be the same as sending in a donation, only this way it is earmarked
  373.     for registering a particular door. In a way, the user feels he/she is
  374.     "getting something in return". As a Door author I have decided to build
  375.     this concept into each of my Door programs. The concept replaces the
  376.     usual message "tell the Sysop to register this Door" we find in most
  377.     doors.
  378.  
  379.     If the Door is unregisterd then a message appears on the opening screen
  380.     to that effect. After finishing or suspending a game, a message screen
  381.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  382.     caller to contact the Sysop to find out if there is any further details
  383.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  384.     time, etc to callers that ADOPT-A-DOOR.
  385.  
  386.     If the Door has been registered, either by the Sysop or other callers,
  387.     the names of those contributors will be displayed in the closing screen.
  388.  
  389.     NOTE: If you want to display the names of the callers that contributed
  390.           to registering the Door, you must create an ASCII file called
  391.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  392.           the name(s) of the contributors (one on each line, maximum of 5
  393.           entries, each a maximum of 30 characters long). This file must be
  394.           saved, in ASCII format, and placed in the Door directory.
  395.  
  396.  
  397.  
  398.                               LEGALITIES
  399.                               __________
  400.  
  401.  
  402.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  403.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  404.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  405.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  406.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  407.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  408.       OR BREACH OF ANY WARRANTY.
  409.  
  410.  
  411.  
  412.  
  413.  
  414.                              DISTRIBUTION
  415.                              ____________
  416.  
  417.    You may make this file available for downloading from your BBS or you may
  418.    upload it to any BBS of your choice, provided that you do not make any
  419.    changes to the contents of the archive (ZIP file). The archive and its
  420.    individual contents may not be used by any service that charges any money
  421.    whatsoever, without the written permission of the author.
  422.  
  423.  
  424.  
  425.  
  426.  
  427.                              REGISTRATION
  428.                              ____________
  429.  
  430.    Registration and the subsequent insertion of the registration number into
  431.    your configuation file, allows for the display of your BBS name on the
  432.    opening and closing screen as well as the reduction of a delay built into
  433.    the opening screen display along with the ability to change certain
  434.    values in the configuration file.
  435.  
  436.    To register your copy of DOMINOES, please fill out the registration form
  437.    (REGISTER.FRM) and mail it along with the registration fee to
  438.    the name and address on the form.
  439.  
  440.    Be sure to use the proper upper/lower case when filling in your name and
  441.    BBS name, as they MUST match the way you entered them in the configuration
  442.    file.             ^^^^
  443.  
  444.    Based upon information supplied on the registration form, I will pre-
  445.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  446.    up your registration number.
  447.  
  448.  
  449.  
  450.                                  MISC
  451.                                  ____
  452.  
  453.    The latest version of DOMINOES and other fine SUNRISE DOOR programs
  454.    are always available for download from SUNRISE-80 BBS and/or SALTAIR BBS.
  455.  
  456.    Remember, should you have any problems, questions or suggestions, be sure
  457.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  458.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  459.  
  460.